<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.net.smtp;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.IOException;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.io.Writer;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.net.InetAddress;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.commons.net.io.DotTerminatedMessageWriter;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    /***<a name="line.26"></a>
<FONT color="green">027</FONT>     * SMTPClient encapsulates all the functionality necessary to send files<a name="line.27"></a>
<FONT color="green">028</FONT>     * through an SMTP server.  This class takes care of all<a name="line.28"></a>
<FONT color="green">029</FONT>     * low level details of interacting with an SMTP server and provides<a name="line.29"></a>
<FONT color="green">030</FONT>     * a convenient higher level interface.  As with all classes derived<a name="line.30"></a>
<FONT color="green">031</FONT>     * from {@link org.apache.commons.net.SocketClient},<a name="line.31"></a>
<FONT color="green">032</FONT>     * you must first connect to the server with<a name="line.32"></a>
<FONT color="green">033</FONT>     * {@link org.apache.commons.net.SocketClient#connect  connect }<a name="line.33"></a>
<FONT color="green">034</FONT>     * before doing anything, and finally<a name="line.34"></a>
<FONT color="green">035</FONT>     * {@link org.apache.commons.net.SocketClient#disconnect  disconnect }<a name="line.35"></a>
<FONT color="green">036</FONT>     * after you're completely finished interacting with the server.<a name="line.36"></a>
<FONT color="green">037</FONT>     * Then you need to check the SMTP reply code to see if the connection<a name="line.37"></a>
<FONT color="green">038</FONT>     * was successful.  For example:<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;pre&gt;<a name="line.39"></a>
<FONT color="green">040</FONT>     *    try {<a name="line.40"></a>
<FONT color="green">041</FONT>     *      int reply;<a name="line.41"></a>
<FONT color="green">042</FONT>     *      client.connect("mail.foobar.com");<a name="line.42"></a>
<FONT color="green">043</FONT>     *      System.out.print(client.getReplyString());<a name="line.43"></a>
<FONT color="green">044</FONT>     *<a name="line.44"></a>
<FONT color="green">045</FONT>     *      // After connection attempt, you should check the reply code to verify<a name="line.45"></a>
<FONT color="green">046</FONT>     *      // success.<a name="line.46"></a>
<FONT color="green">047</FONT>     *      reply = client.getReplyCode();<a name="line.47"></a>
<FONT color="green">048</FONT>     *<a name="line.48"></a>
<FONT color="green">049</FONT>     *      if(!SMTPReply.isPositiveCompletion(reply)) {<a name="line.49"></a>
<FONT color="green">050</FONT>     *        client.disconnect();<a name="line.50"></a>
<FONT color="green">051</FONT>     *        System.err.println("SMTP server refused connection.");<a name="line.51"></a>
<FONT color="green">052</FONT>     *        System.exit(1);<a name="line.52"></a>
<FONT color="green">053</FONT>     *      }<a name="line.53"></a>
<FONT color="green">054</FONT>     *<a name="line.54"></a>
<FONT color="green">055</FONT>     *      // Do useful stuff here.<a name="line.55"></a>
<FONT color="green">056</FONT>     *      ...<a name="line.56"></a>
<FONT color="green">057</FONT>     *    } catch(IOException e) {<a name="line.57"></a>
<FONT color="green">058</FONT>     *      if(client.isConnected()) {<a name="line.58"></a>
<FONT color="green">059</FONT>     *        try {<a name="line.59"></a>
<FONT color="green">060</FONT>     *          client.disconnect();<a name="line.60"></a>
<FONT color="green">061</FONT>     *        } catch(IOException f) {<a name="line.61"></a>
<FONT color="green">062</FONT>     *          // do nothing<a name="line.62"></a>
<FONT color="green">063</FONT>     *        }<a name="line.63"></a>
<FONT color="green">064</FONT>     *      }<a name="line.64"></a>
<FONT color="green">065</FONT>     *      System.err.println("Could not connect to server.");<a name="line.65"></a>
<FONT color="green">066</FONT>     *      e.printStackTrace();<a name="line.66"></a>
<FONT color="green">067</FONT>     *      System.exit(1);<a name="line.67"></a>
<FONT color="green">068</FONT>     *    }<a name="line.68"></a>
<FONT color="green">069</FONT>     * &lt;/pre&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>     * &lt;p&gt;<a name="line.70"></a>
<FONT color="green">071</FONT>     * Immediately after connecting is the only real time you need to check the<a name="line.71"></a>
<FONT color="green">072</FONT>     * reply code (because connect is of type void).  The convention for all the<a name="line.72"></a>
<FONT color="green">073</FONT>     * SMTP command methods in SMTPClient is such that they either return a<a name="line.73"></a>
<FONT color="green">074</FONT>     * boolean value or some other value.<a name="line.74"></a>
<FONT color="green">075</FONT>     * The boolean methods return true on a successful completion reply from<a name="line.75"></a>
<FONT color="green">076</FONT>     * the SMTP server and false on a reply resulting in an error condition or<a name="line.76"></a>
<FONT color="green">077</FONT>     * failure.  The methods returning a value other than boolean return a value<a name="line.77"></a>
<FONT color="green">078</FONT>     * containing the higher level data produced by the SMTP command, or null if a<a name="line.78"></a>
<FONT color="green">079</FONT>     * reply resulted in an error condition or failure.  If you want to access<a name="line.79"></a>
<FONT color="green">080</FONT>     * the exact SMTP reply code causing a success or failure, you must call<a name="line.80"></a>
<FONT color="green">081</FONT>     * {@link org.apache.commons.net.smtp.SMTP#getReplyCode  getReplyCode } after<a name="line.81"></a>
<FONT color="green">082</FONT>     * a success or failure.<a name="line.82"></a>
<FONT color="green">083</FONT>     * &lt;p&gt;<a name="line.83"></a>
<FONT color="green">084</FONT>     * You should keep in mind that the SMTP server may choose to prematurely<a name="line.84"></a>
<FONT color="green">085</FONT>     * close a connection for various reasons.  The SMTPClient class will detect a<a name="line.85"></a>
<FONT color="green">086</FONT>     * premature SMTP server connection closing when it receives a<a name="line.86"></a>
<FONT color="green">087</FONT>     * {@link org.apache.commons.net.smtp.SMTPReply#SERVICE_NOT_AVAILABLE SMTPReply.SERVICE_NOT_AVAILABLE }<a name="line.87"></a>
<FONT color="green">088</FONT>     *  response to a command.<a name="line.88"></a>
<FONT color="green">089</FONT>     * When that occurs, the method encountering that reply will throw<a name="line.89"></a>
<FONT color="green">090</FONT>     * an {@link org.apache.commons.net.smtp.SMTPConnectionClosedException}<a name="line.90"></a>
<FONT color="green">091</FONT>     * .<a name="line.91"></a>
<FONT color="green">092</FONT>     * &lt;code&gt;SMTPConectionClosedException&lt;/code&gt;<a name="line.92"></a>
<FONT color="green">093</FONT>     * is a subclass of &lt;code&gt; IOException &lt;/code&gt; and therefore need not be<a name="line.93"></a>
<FONT color="green">094</FONT>     * caught separately, but if you are going to catch it separately, its<a name="line.94"></a>
<FONT color="green">095</FONT>     * catch block must appear before the more general &lt;code&gt; IOException &lt;/code&gt;<a name="line.95"></a>
<FONT color="green">096</FONT>     * catch block.  When you encounter an<a name="line.96"></a>
<FONT color="green">097</FONT>     * {@link org.apache.commons.net.smtp.SMTPConnectionClosedException}<a name="line.97"></a>
<FONT color="green">098</FONT>     * , you must disconnect the connection with<a name="line.98"></a>
<FONT color="green">099</FONT>     * {@link #disconnect  disconnect() } to properly clean up the<a name="line.99"></a>
<FONT color="green">100</FONT>     * system resources used by SMTPClient.  Before disconnecting, you may check<a name="line.100"></a>
<FONT color="green">101</FONT>     * the last reply code and text with<a name="line.101"></a>
<FONT color="green">102</FONT>     * {@link org.apache.commons.net.smtp.SMTP#getReplyCode  getReplyCode },<a name="line.102"></a>
<FONT color="green">103</FONT>     * {@link org.apache.commons.net.smtp.SMTP#getReplyString  getReplyString },<a name="line.103"></a>
<FONT color="green">104</FONT>     * and<a name="line.104"></a>
<FONT color="green">105</FONT>     * {@link org.apache.commons.net.smtp.SMTP#getReplyStrings getReplyStrings}.<a name="line.105"></a>
<FONT color="green">106</FONT>     * &lt;p&gt;<a name="line.106"></a>
<FONT color="green">107</FONT>     * Rather than list it separately for each method, we mention here that<a name="line.107"></a>
<FONT color="green">108</FONT>     * every method communicating with the server and throwing an IOException<a name="line.108"></a>
<FONT color="green">109</FONT>     * can also throw a<a name="line.109"></a>
<FONT color="green">110</FONT>     * {@link org.apache.commons.net.MalformedServerReplyException}<a name="line.110"></a>
<FONT color="green">111</FONT>     * , which is a subclass<a name="line.111"></a>
<FONT color="green">112</FONT>     * of IOException.  A MalformedServerReplyException will be thrown when<a name="line.112"></a>
<FONT color="green">113</FONT>     * the reply received from the server deviates enough from the protocol<a name="line.113"></a>
<FONT color="green">114</FONT>     * specification that it cannot be interpreted in a useful manner despite<a name="line.114"></a>
<FONT color="green">115</FONT>     * attempts to be as lenient as possible.<a name="line.115"></a>
<FONT color="green">116</FONT>     * &lt;p&gt;<a name="line.116"></a>
<FONT color="green">117</FONT>     * &lt;p&gt;<a name="line.117"></a>
<FONT color="green">118</FONT>     * @see SMTP<a name="line.118"></a>
<FONT color="green">119</FONT>     * @see SimpleSMTPHeader<a name="line.119"></a>
<FONT color="green">120</FONT>     * @see RelayPath<a name="line.120"></a>
<FONT color="green">121</FONT>     * @see SMTPConnectionClosedException<a name="line.121"></a>
<FONT color="green">122</FONT>     * @see org.apache.commons.net.MalformedServerReplyException<a name="line.122"></a>
<FONT color="green">123</FONT>     ***/<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>    public class SMTPClient extends SMTP<a name="line.125"></a>
<FONT color="green">126</FONT>    {<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>        /**<a name="line.128"></a>
<FONT color="green">129</FONT>         * Default SMTPClient constructor.  Creates a new SMTPClient instance.<a name="line.129"></a>
<FONT color="green">130</FONT>         */<a name="line.130"></a>
<FONT color="green">131</FONT>        public SMTPClient() {  }<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>        /**<a name="line.133"></a>
<FONT color="green">134</FONT>         * Overloaded constructor that takes an encoding specification<a name="line.134"></a>
<FONT color="green">135</FONT>         * @param encoding The encoding to use<a name="line.135"></a>
<FONT color="green">136</FONT>         * @since 2.0<a name="line.136"></a>
<FONT color="green">137</FONT>         */<a name="line.137"></a>
<FONT color="green">138</FONT>        public SMTPClient(String encoding) {<a name="line.138"></a>
<FONT color="green">139</FONT>            super(encoding);<a name="line.139"></a>
<FONT color="green">140</FONT>        }<a name="line.140"></a>
<FONT color="green">141</FONT>    <a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>        /***<a name="line.143"></a>
<FONT color="green">144</FONT>         * At least one SMTPClient method ({@link #sendMessageData  sendMessageData })<a name="line.144"></a>
<FONT color="green">145</FONT>         * does not complete the entire sequence of SMTP commands to complete a<a name="line.145"></a>
<FONT color="green">146</FONT>         * transaction.  These types of commands require some action by the<a name="line.146"></a>
<FONT color="green">147</FONT>         * programmer after the reception of a positive intermediate command.<a name="line.147"></a>
<FONT color="green">148</FONT>         * After the programmer's code completes its actions, it must call this<a name="line.148"></a>
<FONT color="green">149</FONT>         * method to receive the completion reply from the server and verify the<a name="line.149"></a>
<FONT color="green">150</FONT>         * success of the entire transaction.<a name="line.150"></a>
<FONT color="green">151</FONT>         * &lt;p&gt;<a name="line.151"></a>
<FONT color="green">152</FONT>         * For example,<a name="line.152"></a>
<FONT color="green">153</FONT>         * &lt;pre&gt;<a name="line.153"></a>
<FONT color="green">154</FONT>         * writer = client.sendMessage();<a name="line.154"></a>
<FONT color="green">155</FONT>         * if(writer == null) // failure<a name="line.155"></a>
<FONT color="green">156</FONT>         *   return false;<a name="line.156"></a>
<FONT color="green">157</FONT>         * header =<a name="line.157"></a>
<FONT color="green">158</FONT>         *  new SimpleSMTPHeader("foobar@foo.com", "foo@foobar.com", "Re: Foo");<a name="line.158"></a>
<FONT color="green">159</FONT>         * writer.write(header.toString());<a name="line.159"></a>
<FONT color="green">160</FONT>         * writer.write("This is just a test");<a name="line.160"></a>
<FONT color="green">161</FONT>         * writer.close();<a name="line.161"></a>
<FONT color="green">162</FONT>         * if(!client.completePendingCommand()) // failure<a name="line.162"></a>
<FONT color="green">163</FONT>         *   return false;<a name="line.163"></a>
<FONT color="green">164</FONT>         * &lt;/pre&gt;<a name="line.164"></a>
<FONT color="green">165</FONT>         * &lt;p&gt;<a name="line.165"></a>
<FONT color="green">166</FONT>         * @return True if successfully completed, false if not.<a name="line.166"></a>
<FONT color="green">167</FONT>         * @exception SMTPConnectionClosedException<a name="line.167"></a>
<FONT color="green">168</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.168"></a>
<FONT color="green">169</FONT>         *      of the client being idle or some other reason causing the server<a name="line.169"></a>
<FONT color="green">170</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.170"></a>
<FONT color="green">171</FONT>         *      as an IOException or independently as itself.<a name="line.171"></a>
<FONT color="green">172</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.172"></a>
<FONT color="green">173</FONT>         *      command to the server or receiving a reply from the server.<a name="line.173"></a>
<FONT color="green">174</FONT>         ***/<a name="line.174"></a>
<FONT color="green">175</FONT>        public boolean completePendingCommand() throws IOException<a name="line.175"></a>
<FONT color="green">176</FONT>        {<a name="line.176"></a>
<FONT color="green">177</FONT>            return SMTPReply.isPositiveCompletion(getReply());<a name="line.177"></a>
<FONT color="green">178</FONT>        }<a name="line.178"></a>
<FONT color="green">179</FONT>    <a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>        /***<a name="line.181"></a>
<FONT color="green">182</FONT>         * Login to the SMTP server by sending the HELO command with the<a name="line.182"></a>
<FONT color="green">183</FONT>         * given hostname as an argument.  Before performing any mail commands,<a name="line.183"></a>
<FONT color="green">184</FONT>         * you must first login.<a name="line.184"></a>
<FONT color="green">185</FONT>         * &lt;p&gt;<a name="line.185"></a>
<FONT color="green">186</FONT>         * @param hostname  The hostname with which to greet the SMTP server.<a name="line.186"></a>
<FONT color="green">187</FONT>         * @return True if successfully completed, false if not.<a name="line.187"></a>
<FONT color="green">188</FONT>         * @exception SMTPConnectionClosedException<a name="line.188"></a>
<FONT color="green">189</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.189"></a>
<FONT color="green">190</FONT>         *      of the client being idle or some other reason causing the server<a name="line.190"></a>
<FONT color="green">191</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.191"></a>
<FONT color="green">192</FONT>         *      as an IOException or independently as itself.<a name="line.192"></a>
<FONT color="green">193</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.193"></a>
<FONT color="green">194</FONT>         *      command to the server or receiving a reply from the server.<a name="line.194"></a>
<FONT color="green">195</FONT>         ***/<a name="line.195"></a>
<FONT color="green">196</FONT>        public boolean login(String hostname) throws IOException<a name="line.196"></a>
<FONT color="green">197</FONT>        {<a name="line.197"></a>
<FONT color="green">198</FONT>            return SMTPReply.isPositiveCompletion(helo(hostname));<a name="line.198"></a>
<FONT color="green">199</FONT>        }<a name="line.199"></a>
<FONT color="green">200</FONT>    <a name="line.200"></a>
<FONT color="green">201</FONT>    <a name="line.201"></a>
<FONT color="green">202</FONT>        /***<a name="line.202"></a>
<FONT color="green">203</FONT>         * Login to the SMTP server by sending the HELO command with the<a name="line.203"></a>
<FONT color="green">204</FONT>         * client hostname as an argument.  Before performing any mail commands,<a name="line.204"></a>
<FONT color="green">205</FONT>         * you must first login.<a name="line.205"></a>
<FONT color="green">206</FONT>         * &lt;p&gt;<a name="line.206"></a>
<FONT color="green">207</FONT>         * @return True if successfully completed, false if not.<a name="line.207"></a>
<FONT color="green">208</FONT>         * @exception SMTPConnectionClosedException<a name="line.208"></a>
<FONT color="green">209</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.209"></a>
<FONT color="green">210</FONT>         *      of the client being idle or some other reason causing the server<a name="line.210"></a>
<FONT color="green">211</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.211"></a>
<FONT color="green">212</FONT>         *      as an IOException or independently as itself.<a name="line.212"></a>
<FONT color="green">213</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.213"></a>
<FONT color="green">214</FONT>         *      command to the server or receiving a reply from the server.<a name="line.214"></a>
<FONT color="green">215</FONT>         ***/<a name="line.215"></a>
<FONT color="green">216</FONT>        public boolean login() throws IOException<a name="line.216"></a>
<FONT color="green">217</FONT>        {<a name="line.217"></a>
<FONT color="green">218</FONT>            String name;<a name="line.218"></a>
<FONT color="green">219</FONT>            InetAddress host;<a name="line.219"></a>
<FONT color="green">220</FONT>    <a name="line.220"></a>
<FONT color="green">221</FONT>            host = getLocalAddress();<a name="line.221"></a>
<FONT color="green">222</FONT>            name = host.getHostName();<a name="line.222"></a>
<FONT color="green">223</FONT>    <a name="line.223"></a>
<FONT color="green">224</FONT>            if (name == null) {<a name="line.224"></a>
<FONT color="green">225</FONT>                return false;<a name="line.225"></a>
<FONT color="green">226</FONT>            }<a name="line.226"></a>
<FONT color="green">227</FONT>    <a name="line.227"></a>
<FONT color="green">228</FONT>            return SMTPReply.isPositiveCompletion(helo(name));<a name="line.228"></a>
<FONT color="green">229</FONT>        }<a name="line.229"></a>
<FONT color="green">230</FONT>    <a name="line.230"></a>
<FONT color="green">231</FONT>    <a name="line.231"></a>
<FONT color="green">232</FONT>        /***<a name="line.232"></a>
<FONT color="green">233</FONT>         * Set the sender of a message using the SMTP MAIL command, specifying<a name="line.233"></a>
<FONT color="green">234</FONT>         * a reverse relay path.  The sender must be set first before any<a name="line.234"></a>
<FONT color="green">235</FONT>         * recipients may be specified, otherwise the mail server will reject<a name="line.235"></a>
<FONT color="green">236</FONT>         * your commands.<a name="line.236"></a>
<FONT color="green">237</FONT>         * &lt;p&gt;<a name="line.237"></a>
<FONT color="green">238</FONT>         * @param path  The reverse relay path pointing back to the sender.<a name="line.238"></a>
<FONT color="green">239</FONT>         * @return True if successfully completed, false if not.<a name="line.239"></a>
<FONT color="green">240</FONT>         * @exception SMTPConnectionClosedException<a name="line.240"></a>
<FONT color="green">241</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.241"></a>
<FONT color="green">242</FONT>         *      of the client being idle or some other reason causing the server<a name="line.242"></a>
<FONT color="green">243</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.243"></a>
<FONT color="green">244</FONT>         *      as an IOException or independently as itself.<a name="line.244"></a>
<FONT color="green">245</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.245"></a>
<FONT color="green">246</FONT>         *      command to the server or receiving a reply from the server.<a name="line.246"></a>
<FONT color="green">247</FONT>         ***/<a name="line.247"></a>
<FONT color="green">248</FONT>        public boolean setSender(RelayPath path) throws IOException<a name="line.248"></a>
<FONT color="green">249</FONT>        {<a name="line.249"></a>
<FONT color="green">250</FONT>            return SMTPReply.isPositiveCompletion(mail(path.toString()));<a name="line.250"></a>
<FONT color="green">251</FONT>        }<a name="line.251"></a>
<FONT color="green">252</FONT>    <a name="line.252"></a>
<FONT color="green">253</FONT>    <a name="line.253"></a>
<FONT color="green">254</FONT>        /***<a name="line.254"></a>
<FONT color="green">255</FONT>         * Set the sender of a message using the SMTP MAIL command, specifying<a name="line.255"></a>
<FONT color="green">256</FONT>         * the sender's email address. The sender must be set first before any<a name="line.256"></a>
<FONT color="green">257</FONT>         * recipients may be specified, otherwise the mail server will reject<a name="line.257"></a>
<FONT color="green">258</FONT>         * your commands.<a name="line.258"></a>
<FONT color="green">259</FONT>         * &lt;p&gt;<a name="line.259"></a>
<FONT color="green">260</FONT>         * @param address  The sender's email address.<a name="line.260"></a>
<FONT color="green">261</FONT>         * @return True if successfully completed, false if not.<a name="line.261"></a>
<FONT color="green">262</FONT>         * @exception SMTPConnectionClosedException<a name="line.262"></a>
<FONT color="green">263</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.263"></a>
<FONT color="green">264</FONT>         *      of the client being idle or some other reason causing the server<a name="line.264"></a>
<FONT color="green">265</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.265"></a>
<FONT color="green">266</FONT>         *      as an IOException or independently as itself.<a name="line.266"></a>
<FONT color="green">267</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.267"></a>
<FONT color="green">268</FONT>         *      command to the server or receiving a reply from the server.<a name="line.268"></a>
<FONT color="green">269</FONT>         ***/<a name="line.269"></a>
<FONT color="green">270</FONT>        public boolean setSender(String address) throws IOException<a name="line.270"></a>
<FONT color="green">271</FONT>        {<a name="line.271"></a>
<FONT color="green">272</FONT>            return SMTPReply.isPositiveCompletion(mail("&lt;" + address + "&gt;"));<a name="line.272"></a>
<FONT color="green">273</FONT>        }<a name="line.273"></a>
<FONT color="green">274</FONT>    <a name="line.274"></a>
<FONT color="green">275</FONT>    <a name="line.275"></a>
<FONT color="green">276</FONT>        /***<a name="line.276"></a>
<FONT color="green">277</FONT>         * Add a recipient for a message using the SMTP RCPT command, specifying<a name="line.277"></a>
<FONT color="green">278</FONT>         * a forward relay path.  The sender must be set first before any<a name="line.278"></a>
<FONT color="green">279</FONT>         * recipients may be specified, otherwise the mail server will reject<a name="line.279"></a>
<FONT color="green">280</FONT>         * your commands.<a name="line.280"></a>
<FONT color="green">281</FONT>         * &lt;p&gt;<a name="line.281"></a>
<FONT color="green">282</FONT>         * @param path  The forward relay path pointing to the recipient.<a name="line.282"></a>
<FONT color="green">283</FONT>         * @return True if successfully completed, false if not.<a name="line.283"></a>
<FONT color="green">284</FONT>         * @exception SMTPConnectionClosedException<a name="line.284"></a>
<FONT color="green">285</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.285"></a>
<FONT color="green">286</FONT>         *      of the client being idle or some other reason causing the server<a name="line.286"></a>
<FONT color="green">287</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.287"></a>
<FONT color="green">288</FONT>         *      as an IOException or independently as itself.<a name="line.288"></a>
<FONT color="green">289</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.289"></a>
<FONT color="green">290</FONT>         *      command to the server or receiving a reply from the server.<a name="line.290"></a>
<FONT color="green">291</FONT>         ***/<a name="line.291"></a>
<FONT color="green">292</FONT>        public boolean addRecipient(RelayPath path) throws IOException<a name="line.292"></a>
<FONT color="green">293</FONT>        {<a name="line.293"></a>
<FONT color="green">294</FONT>            return SMTPReply.isPositiveCompletion(rcpt(path.toString()));<a name="line.294"></a>
<FONT color="green">295</FONT>        }<a name="line.295"></a>
<FONT color="green">296</FONT>    <a name="line.296"></a>
<FONT color="green">297</FONT>    <a name="line.297"></a>
<FONT color="green">298</FONT>        /***<a name="line.298"></a>
<FONT color="green">299</FONT>         * Add a recipient for a message using the SMTP RCPT command, the<a name="line.299"></a>
<FONT color="green">300</FONT>         * recipient's email address.  The sender must be set first before any<a name="line.300"></a>
<FONT color="green">301</FONT>         * recipients may be specified, otherwise the mail server will reject<a name="line.301"></a>
<FONT color="green">302</FONT>         * your commands.<a name="line.302"></a>
<FONT color="green">303</FONT>         * &lt;p&gt;<a name="line.303"></a>
<FONT color="green">304</FONT>         * @param address  The recipient's email address.<a name="line.304"></a>
<FONT color="green">305</FONT>         * @return True if successfully completed, false if not.<a name="line.305"></a>
<FONT color="green">306</FONT>         * @exception SMTPConnectionClosedException<a name="line.306"></a>
<FONT color="green">307</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.307"></a>
<FONT color="green">308</FONT>         *      of the client being idle or some other reason causing the server<a name="line.308"></a>
<FONT color="green">309</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.309"></a>
<FONT color="green">310</FONT>         *      as an IOException or independently as itself.<a name="line.310"></a>
<FONT color="green">311</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.311"></a>
<FONT color="green">312</FONT>         *      command to the server or receiving a reply from the server.<a name="line.312"></a>
<FONT color="green">313</FONT>         ***/<a name="line.313"></a>
<FONT color="green">314</FONT>        public boolean addRecipient(String address) throws IOException<a name="line.314"></a>
<FONT color="green">315</FONT>        {<a name="line.315"></a>
<FONT color="green">316</FONT>            return SMTPReply.isPositiveCompletion(rcpt("&lt;" + address + "&gt;"));<a name="line.316"></a>
<FONT color="green">317</FONT>        }<a name="line.317"></a>
<FONT color="green">318</FONT>    <a name="line.318"></a>
<FONT color="green">319</FONT>    <a name="line.319"></a>
<FONT color="green">320</FONT>    <a name="line.320"></a>
<FONT color="green">321</FONT>        /***<a name="line.321"></a>
<FONT color="green">322</FONT>         * Send the SMTP DATA command in preparation to send an email message.<a name="line.322"></a>
<FONT color="green">323</FONT>         * This method returns a DotTerminatedMessageWriter instance to which<a name="line.323"></a>
<FONT color="green">324</FONT>         * the message can be written.  Null is returned if the DATA command<a name="line.324"></a>
<FONT color="green">325</FONT>         * fails.<a name="line.325"></a>
<FONT color="green">326</FONT>         * &lt;p&gt;<a name="line.326"></a>
<FONT color="green">327</FONT>         * You must not issue any commands to the SMTP server (i.e., call any<a name="line.327"></a>
<FONT color="green">328</FONT>         * (other methods) until you finish writing to the returned Writer<a name="line.328"></a>
<FONT color="green">329</FONT>         * instance and close it.  The SMTP protocol uses the same stream for<a name="line.329"></a>
<FONT color="green">330</FONT>         * issuing commands as it does for returning results.  Therefore the<a name="line.330"></a>
<FONT color="green">331</FONT>         * returned Writer actually writes directly to the SMTP connection.<a name="line.331"></a>
<FONT color="green">332</FONT>         * After you close the writer, you can execute new commands.  If you<a name="line.332"></a>
<FONT color="green">333</FONT>         * do not follow these requirements your program will not work properly.<a name="line.333"></a>
<FONT color="green">334</FONT>         * &lt;p&gt;<a name="line.334"></a>
<FONT color="green">335</FONT>         * You can use the provided<a name="line.335"></a>
<FONT color="green">336</FONT>         * {@link org.apache.commons.net.smtp.SimpleSMTPHeader}<a name="line.336"></a>
<FONT color="green">337</FONT>         * class to construct a bare minimum header.<a name="line.337"></a>
<FONT color="green">338</FONT>         * To construct more complicated headers you should<a name="line.338"></a>
<FONT color="green">339</FONT>         * refer to RFC 822.  When the Java Mail API is finalized, you will be<a name="line.339"></a>
<FONT color="green">340</FONT>         * able to use it to compose fully compliant Internet text messages.<a name="line.340"></a>
<FONT color="green">341</FONT>         * The DotTerminatedMessageWriter takes care of doubling line-leading<a name="line.341"></a>
<FONT color="green">342</FONT>         * dots and ending the message with a single dot upon closing, so all<a name="line.342"></a>
<FONT color="green">343</FONT>         * you have to worry about is writing the header and the message.<a name="line.343"></a>
<FONT color="green">344</FONT>         * &lt;p&gt;<a name="line.344"></a>
<FONT color="green">345</FONT>         * Upon closing the returned Writer, you need to call<a name="line.345"></a>
<FONT color="green">346</FONT>         * {@link #completePendingCommand  completePendingCommand() }<a name="line.346"></a>
<FONT color="green">347</FONT>         * to finalize the transaction and verify its success or failure from<a name="line.347"></a>
<FONT color="green">348</FONT>         * the server reply.<a name="line.348"></a>
<FONT color="green">349</FONT>         * &lt;p&gt;<a name="line.349"></a>
<FONT color="green">350</FONT>         * @return A DotTerminatedMessageWriter to which the message (including<a name="line.350"></a>
<FONT color="green">351</FONT>         *      header) can be written.  Returns null if the command fails.<a name="line.351"></a>
<FONT color="green">352</FONT>         * @exception SMTPConnectionClosedException<a name="line.352"></a>
<FONT color="green">353</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.353"></a>
<FONT color="green">354</FONT>         *      of the client being idle or some other reason causing the server<a name="line.354"></a>
<FONT color="green">355</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.355"></a>
<FONT color="green">356</FONT>         *      as an IOException or independently as itself.<a name="line.356"></a>
<FONT color="green">357</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.357"></a>
<FONT color="green">358</FONT>         *      command to the server or receiving a reply from the server.<a name="line.358"></a>
<FONT color="green">359</FONT>         ***/<a name="line.359"></a>
<FONT color="green">360</FONT>        public Writer sendMessageData() throws IOException<a name="line.360"></a>
<FONT color="green">361</FONT>        {<a name="line.361"></a>
<FONT color="green">362</FONT>            if (!SMTPReply.isPositiveIntermediate(data())) {<a name="line.362"></a>
<FONT color="green">363</FONT>                return null;<a name="line.363"></a>
<FONT color="green">364</FONT>            }<a name="line.364"></a>
<FONT color="green">365</FONT>    <a name="line.365"></a>
<FONT color="green">366</FONT>            return new DotTerminatedMessageWriter(_writer);<a name="line.366"></a>
<FONT color="green">367</FONT>        }<a name="line.367"></a>
<FONT color="green">368</FONT>    <a name="line.368"></a>
<FONT color="green">369</FONT>    <a name="line.369"></a>
<FONT color="green">370</FONT>        /***<a name="line.370"></a>
<FONT color="green">371</FONT>         * A convenience method for sending short messages.  This method fetches<a name="line.371"></a>
<FONT color="green">372</FONT>         * the Writer returned by {@link #sendMessageData  sendMessageData() }<a name="line.372"></a>
<FONT color="green">373</FONT>         * and writes the specified String to it.  After writing the message,<a name="line.373"></a>
<FONT color="green">374</FONT>         * this method calls {@link #completePendingCommand completePendingCommand() }<a name="line.374"></a>
<FONT color="green">375</FONT>         *  to finalize the transaction and returns<a name="line.375"></a>
<FONT color="green">376</FONT>         * its success or failure.<a name="line.376"></a>
<FONT color="green">377</FONT>         * &lt;p&gt;<a name="line.377"></a>
<FONT color="green">378</FONT>         * @param message  The short email message to send.<a name="line.378"></a>
<FONT color="green">379</FONT>         * @return True if successfully completed, false if not.<a name="line.379"></a>
<FONT color="green">380</FONT>         * @exception SMTPConnectionClosedException<a name="line.380"></a>
<FONT color="green">381</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.381"></a>
<FONT color="green">382</FONT>         *      of the client being idle or some other reason causing the server<a name="line.382"></a>
<FONT color="green">383</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.383"></a>
<FONT color="green">384</FONT>         *      as an IOException or independently as itself.<a name="line.384"></a>
<FONT color="green">385</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.385"></a>
<FONT color="green">386</FONT>         *      command to the server or receiving a reply from the server.<a name="line.386"></a>
<FONT color="green">387</FONT>         ***/<a name="line.387"></a>
<FONT color="green">388</FONT>        public boolean sendShortMessageData(String message) throws IOException<a name="line.388"></a>
<FONT color="green">389</FONT>        {<a name="line.389"></a>
<FONT color="green">390</FONT>            Writer writer;<a name="line.390"></a>
<FONT color="green">391</FONT>    <a name="line.391"></a>
<FONT color="green">392</FONT>            writer = sendMessageData();<a name="line.392"></a>
<FONT color="green">393</FONT>    <a name="line.393"></a>
<FONT color="green">394</FONT>            if (writer == null) {<a name="line.394"></a>
<FONT color="green">395</FONT>                return false;<a name="line.395"></a>
<FONT color="green">396</FONT>            }<a name="line.396"></a>
<FONT color="green">397</FONT>    <a name="line.397"></a>
<FONT color="green">398</FONT>            writer.write(message);<a name="line.398"></a>
<FONT color="green">399</FONT>            writer.close();<a name="line.399"></a>
<FONT color="green">400</FONT>    <a name="line.400"></a>
<FONT color="green">401</FONT>            return completePendingCommand();<a name="line.401"></a>
<FONT color="green">402</FONT>        }<a name="line.402"></a>
<FONT color="green">403</FONT>    <a name="line.403"></a>
<FONT color="green">404</FONT>    <a name="line.404"></a>
<FONT color="green">405</FONT>        /***<a name="line.405"></a>
<FONT color="green">406</FONT>         * A convenience method for a sending short email without having to<a name="line.406"></a>
<FONT color="green">407</FONT>         * explicitly set the sender and recipient(s).  This method<a name="line.407"></a>
<FONT color="green">408</FONT>         * sets the sender and recipient using<a name="line.408"></a>
<FONT color="green">409</FONT>         * {@link #setSender  setSender } and<a name="line.409"></a>
<FONT color="green">410</FONT>         * {@link #addRecipient  addRecipient }, and then sends the<a name="line.410"></a>
<FONT color="green">411</FONT>         * message using {@link #sendShortMessageData  sendShortMessageData }.<a name="line.411"></a>
<FONT color="green">412</FONT>         * &lt;p&gt;<a name="line.412"></a>
<FONT color="green">413</FONT>         * @param sender  The email address of the sender.<a name="line.413"></a>
<FONT color="green">414</FONT>         * @param recipient  The email address of the recipient.<a name="line.414"></a>
<FONT color="green">415</FONT>         * @param message  The short email message to send.<a name="line.415"></a>
<FONT color="green">416</FONT>         * @return True if successfully completed, false if not.<a name="line.416"></a>
<FONT color="green">417</FONT>         * @exception SMTPConnectionClosedException<a name="line.417"></a>
<FONT color="green">418</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.418"></a>
<FONT color="green">419</FONT>         *      of the client being idle or some other reason causing the server<a name="line.419"></a>
<FONT color="green">420</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.420"></a>
<FONT color="green">421</FONT>         *      as an IOException or independently as itself.<a name="line.421"></a>
<FONT color="green">422</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.422"></a>
<FONT color="green">423</FONT>         *      command to the server or receiving a reply from the server.<a name="line.423"></a>
<FONT color="green">424</FONT>         ***/<a name="line.424"></a>
<FONT color="green">425</FONT>        public boolean sendSimpleMessage(String sender, String recipient,<a name="line.425"></a>
<FONT color="green">426</FONT>                                         String message)<a name="line.426"></a>
<FONT color="green">427</FONT>        throws IOException<a name="line.427"></a>
<FONT color="green">428</FONT>        {<a name="line.428"></a>
<FONT color="green">429</FONT>            if (!setSender(sender)) {<a name="line.429"></a>
<FONT color="green">430</FONT>                return false;<a name="line.430"></a>
<FONT color="green">431</FONT>            }<a name="line.431"></a>
<FONT color="green">432</FONT>    <a name="line.432"></a>
<FONT color="green">433</FONT>            if (!addRecipient(recipient)) {<a name="line.433"></a>
<FONT color="green">434</FONT>                return false;<a name="line.434"></a>
<FONT color="green">435</FONT>            }<a name="line.435"></a>
<FONT color="green">436</FONT>    <a name="line.436"></a>
<FONT color="green">437</FONT>            return sendShortMessageData(message);<a name="line.437"></a>
<FONT color="green">438</FONT>        }<a name="line.438"></a>
<FONT color="green">439</FONT>    <a name="line.439"></a>
<FONT color="green">440</FONT>    <a name="line.440"></a>
<FONT color="green">441</FONT>    <a name="line.441"></a>
<FONT color="green">442</FONT>        /***<a name="line.442"></a>
<FONT color="green">443</FONT>         * A convenience method for a sending short email without having to<a name="line.443"></a>
<FONT color="green">444</FONT>         * explicitly set the sender and recipient(s).  This method<a name="line.444"></a>
<FONT color="green">445</FONT>         * sets the sender and recipients using<a name="line.445"></a>
<FONT color="green">446</FONT>         * {@link #setSender  setSender } and<a name="line.446"></a>
<FONT color="green">447</FONT>         * {@link #addRecipient  addRecipient }, and then sends the<a name="line.447"></a>
<FONT color="green">448</FONT>         * message using {@link #sendShortMessageData  sendShortMessageData }.<a name="line.448"></a>
<FONT color="green">449</FONT>         * &lt;p&gt;<a name="line.449"></a>
<FONT color="green">450</FONT>         * @param sender  The email address of the sender.<a name="line.450"></a>
<FONT color="green">451</FONT>         * @param recipients  An array of recipient email addresses.<a name="line.451"></a>
<FONT color="green">452</FONT>         * @param message  The short email message to send.<a name="line.452"></a>
<FONT color="green">453</FONT>         * @return True if successfully completed, false if not.<a name="line.453"></a>
<FONT color="green">454</FONT>         * @exception SMTPConnectionClosedException<a name="line.454"></a>
<FONT color="green">455</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.455"></a>
<FONT color="green">456</FONT>         *      of the client being idle or some other reason causing the server<a name="line.456"></a>
<FONT color="green">457</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.457"></a>
<FONT color="green">458</FONT>         *      as an IOException or independently as itself.<a name="line.458"></a>
<FONT color="green">459</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.459"></a>
<FONT color="green">460</FONT>         *      command to the server or receiving a reply from the server.<a name="line.460"></a>
<FONT color="green">461</FONT>         ***/<a name="line.461"></a>
<FONT color="green">462</FONT>        public boolean sendSimpleMessage(String sender, String[] recipients,<a name="line.462"></a>
<FONT color="green">463</FONT>                                         String message)<a name="line.463"></a>
<FONT color="green">464</FONT>        throws IOException<a name="line.464"></a>
<FONT color="green">465</FONT>        {<a name="line.465"></a>
<FONT color="green">466</FONT>            boolean oneSuccess = false;<a name="line.466"></a>
<FONT color="green">467</FONT>            int count;<a name="line.467"></a>
<FONT color="green">468</FONT>    <a name="line.468"></a>
<FONT color="green">469</FONT>            if (!setSender(sender)) {<a name="line.469"></a>
<FONT color="green">470</FONT>                return false;<a name="line.470"></a>
<FONT color="green">471</FONT>            }<a name="line.471"></a>
<FONT color="green">472</FONT>    <a name="line.472"></a>
<FONT color="green">473</FONT>            for (count = 0; count &lt; recipients.length; count++)<a name="line.473"></a>
<FONT color="green">474</FONT>            {<a name="line.474"></a>
<FONT color="green">475</FONT>                if (addRecipient(recipients[count])) {<a name="line.475"></a>
<FONT color="green">476</FONT>                    oneSuccess = true;<a name="line.476"></a>
<FONT color="green">477</FONT>                }<a name="line.477"></a>
<FONT color="green">478</FONT>            }<a name="line.478"></a>
<FONT color="green">479</FONT>    <a name="line.479"></a>
<FONT color="green">480</FONT>            if (!oneSuccess) {<a name="line.480"></a>
<FONT color="green">481</FONT>                return false;<a name="line.481"></a>
<FONT color="green">482</FONT>            }<a name="line.482"></a>
<FONT color="green">483</FONT>    <a name="line.483"></a>
<FONT color="green">484</FONT>            return sendShortMessageData(message);<a name="line.484"></a>
<FONT color="green">485</FONT>        }<a name="line.485"></a>
<FONT color="green">486</FONT>    <a name="line.486"></a>
<FONT color="green">487</FONT>    <a name="line.487"></a>
<FONT color="green">488</FONT>        /***<a name="line.488"></a>
<FONT color="green">489</FONT>         * Logout of the SMTP server by sending the QUIT command.<a name="line.489"></a>
<FONT color="green">490</FONT>         * &lt;p&gt;<a name="line.490"></a>
<FONT color="green">491</FONT>         * @return True if successfully completed, false if not.<a name="line.491"></a>
<FONT color="green">492</FONT>         * @exception SMTPConnectionClosedException<a name="line.492"></a>
<FONT color="green">493</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.493"></a>
<FONT color="green">494</FONT>         *      of the client being idle or some other reason causing the server<a name="line.494"></a>
<FONT color="green">495</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.495"></a>
<FONT color="green">496</FONT>         *      as an IOException or independently as itself.<a name="line.496"></a>
<FONT color="green">497</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.497"></a>
<FONT color="green">498</FONT>         *      command to the server or receiving a reply from the server.<a name="line.498"></a>
<FONT color="green">499</FONT>         ***/<a name="line.499"></a>
<FONT color="green">500</FONT>        public boolean logout() throws IOException<a name="line.500"></a>
<FONT color="green">501</FONT>        {<a name="line.501"></a>
<FONT color="green">502</FONT>            return SMTPReply.isPositiveCompletion(quit());<a name="line.502"></a>
<FONT color="green">503</FONT>        }<a name="line.503"></a>
<FONT color="green">504</FONT>    <a name="line.504"></a>
<FONT color="green">505</FONT>    <a name="line.505"></a>
<FONT color="green">506</FONT>    <a name="line.506"></a>
<FONT color="green">507</FONT>        /***<a name="line.507"></a>
<FONT color="green">508</FONT>         * Aborts the current mail transaction, resetting all server stored<a name="line.508"></a>
<FONT color="green">509</FONT>         * sender, recipient, and mail data, cleaing all buffers and tables.<a name="line.509"></a>
<FONT color="green">510</FONT>         * &lt;p&gt;<a name="line.510"></a>
<FONT color="green">511</FONT>         * @return True if successfully completed, false if not.<a name="line.511"></a>
<FONT color="green">512</FONT>         * @exception SMTPConnectionClosedException<a name="line.512"></a>
<FONT color="green">513</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.513"></a>
<FONT color="green">514</FONT>         *      of the client being idle or some other reason causing the server<a name="line.514"></a>
<FONT color="green">515</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.515"></a>
<FONT color="green">516</FONT>         *      as an IOException or independently as itself.<a name="line.516"></a>
<FONT color="green">517</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.517"></a>
<FONT color="green">518</FONT>         *      command to the server or receiving a reply from the server.<a name="line.518"></a>
<FONT color="green">519</FONT>         ***/<a name="line.519"></a>
<FONT color="green">520</FONT>        public boolean reset() throws IOException<a name="line.520"></a>
<FONT color="green">521</FONT>        {<a name="line.521"></a>
<FONT color="green">522</FONT>            return SMTPReply.isPositiveCompletion(rset());<a name="line.522"></a>
<FONT color="green">523</FONT>        }<a name="line.523"></a>
<FONT color="green">524</FONT>    <a name="line.524"></a>
<FONT color="green">525</FONT>    <a name="line.525"></a>
<FONT color="green">526</FONT>        /***<a name="line.526"></a>
<FONT color="green">527</FONT>         * Verify that a username or email address is valid, i.e., that mail<a name="line.527"></a>
<FONT color="green">528</FONT>         * can be delivered to that mailbox on the server.<a name="line.528"></a>
<FONT color="green">529</FONT>         * &lt;p&gt;<a name="line.529"></a>
<FONT color="green">530</FONT>         * @param username  The username or email address to validate.<a name="line.530"></a>
<FONT color="green">531</FONT>         * @return True if the username is valid, false if not.<a name="line.531"></a>
<FONT color="green">532</FONT>         * @exception SMTPConnectionClosedException<a name="line.532"></a>
<FONT color="green">533</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.533"></a>
<FONT color="green">534</FONT>         *      of the client being idle or some other reason causing the server<a name="line.534"></a>
<FONT color="green">535</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.535"></a>
<FONT color="green">536</FONT>         *      as an IOException or independently as itself.<a name="line.536"></a>
<FONT color="green">537</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.537"></a>
<FONT color="green">538</FONT>         *      command to the server or receiving a reply from the server.<a name="line.538"></a>
<FONT color="green">539</FONT>         ***/<a name="line.539"></a>
<FONT color="green">540</FONT>        public boolean verify(String username) throws IOException<a name="line.540"></a>
<FONT color="green">541</FONT>        {<a name="line.541"></a>
<FONT color="green">542</FONT>            int result;<a name="line.542"></a>
<FONT color="green">543</FONT>    <a name="line.543"></a>
<FONT color="green">544</FONT>            result = vrfy(username);<a name="line.544"></a>
<FONT color="green">545</FONT>    <a name="line.545"></a>
<FONT color="green">546</FONT>            return (result == SMTPReply.ACTION_OK ||<a name="line.546"></a>
<FONT color="green">547</FONT>                    result == SMTPReply.USER_NOT_LOCAL_WILL_FORWARD);<a name="line.547"></a>
<FONT color="green">548</FONT>        }<a name="line.548"></a>
<FONT color="green">549</FONT>    <a name="line.549"></a>
<FONT color="green">550</FONT>    <a name="line.550"></a>
<FONT color="green">551</FONT>        /***<a name="line.551"></a>
<FONT color="green">552</FONT>         * Fetches the system help information from the server and returns the<a name="line.552"></a>
<FONT color="green">553</FONT>         * full string.<a name="line.553"></a>
<FONT color="green">554</FONT>         * &lt;p&gt;<a name="line.554"></a>
<FONT color="green">555</FONT>         * @return The system help string obtained from the server.  null if the<a name="line.555"></a>
<FONT color="green">556</FONT>         *       information could not be obtained.<a name="line.556"></a>
<FONT color="green">557</FONT>         * @exception SMTPConnectionClosedException<a name="line.557"></a>
<FONT color="green">558</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.558"></a>
<FONT color="green">559</FONT>         *      of the client being idle or some other reason causing the server<a name="line.559"></a>
<FONT color="green">560</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.560"></a>
<FONT color="green">561</FONT>         *      as an IOException or independently as itself.<a name="line.561"></a>
<FONT color="green">562</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.562"></a>
<FONT color="green">563</FONT>         *  command to the server or receiving a reply from the server.<a name="line.563"></a>
<FONT color="green">564</FONT>         ***/<a name="line.564"></a>
<FONT color="green">565</FONT>        public String listHelp() throws IOException<a name="line.565"></a>
<FONT color="green">566</FONT>        {<a name="line.566"></a>
<FONT color="green">567</FONT>            if (SMTPReply.isPositiveCompletion(help())) {<a name="line.567"></a>
<FONT color="green">568</FONT>                return getReplyString();<a name="line.568"></a>
<FONT color="green">569</FONT>            }<a name="line.569"></a>
<FONT color="green">570</FONT>            return null;<a name="line.570"></a>
<FONT color="green">571</FONT>        }<a name="line.571"></a>
<FONT color="green">572</FONT>    <a name="line.572"></a>
<FONT color="green">573</FONT>    <a name="line.573"></a>
<FONT color="green">574</FONT>        /***<a name="line.574"></a>
<FONT color="green">575</FONT>         * Fetches the help information for a given command from the server and<a name="line.575"></a>
<FONT color="green">576</FONT>         * returns the full string.<a name="line.576"></a>
<FONT color="green">577</FONT>         * &lt;p&gt;<a name="line.577"></a>
<FONT color="green">578</FONT>         * @param command The command on which to ask for help.<a name="line.578"></a>
<FONT color="green">579</FONT>         * @return The command help string obtained from the server.  null if the<a name="line.579"></a>
<FONT color="green">580</FONT>         *       information could not be obtained.<a name="line.580"></a>
<FONT color="green">581</FONT>         * @exception SMTPConnectionClosedException<a name="line.581"></a>
<FONT color="green">582</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.582"></a>
<FONT color="green">583</FONT>         *      of the client being idle or some other reason causing the server<a name="line.583"></a>
<FONT color="green">584</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.584"></a>
<FONT color="green">585</FONT>         *      as an IOException or independently as itself.<a name="line.585"></a>
<FONT color="green">586</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.586"></a>
<FONT color="green">587</FONT>         *  command to the server or receiving a reply from the server.<a name="line.587"></a>
<FONT color="green">588</FONT>         ***/<a name="line.588"></a>
<FONT color="green">589</FONT>        public String listHelp(String command) throws IOException<a name="line.589"></a>
<FONT color="green">590</FONT>        {<a name="line.590"></a>
<FONT color="green">591</FONT>            if (SMTPReply.isPositiveCompletion(help(command))) {<a name="line.591"></a>
<FONT color="green">592</FONT>                return getReplyString();<a name="line.592"></a>
<FONT color="green">593</FONT>            }<a name="line.593"></a>
<FONT color="green">594</FONT>            return null;<a name="line.594"></a>
<FONT color="green">595</FONT>        }<a name="line.595"></a>
<FONT color="green">596</FONT>    <a name="line.596"></a>
<FONT color="green">597</FONT>    <a name="line.597"></a>
<FONT color="green">598</FONT>        /***<a name="line.598"></a>
<FONT color="green">599</FONT>         * Sends a NOOP command to the SMTP server.  This is useful for preventing<a name="line.599"></a>
<FONT color="green">600</FONT>         * server timeouts.<a name="line.600"></a>
<FONT color="green">601</FONT>         * &lt;p&gt;<a name="line.601"></a>
<FONT color="green">602</FONT>         * @return True if successfully completed, false if not.<a name="line.602"></a>
<FONT color="green">603</FONT>         * @exception SMTPConnectionClosedException<a name="line.603"></a>
<FONT color="green">604</FONT>         *      If the SMTP server prematurely closes the connection as a result<a name="line.604"></a>
<FONT color="green">605</FONT>         *      of the client being idle or some other reason causing the server<a name="line.605"></a>
<FONT color="green">606</FONT>         *      to send SMTP reply code 421.  This exception may be caught either<a name="line.606"></a>
<FONT color="green">607</FONT>         *      as an IOException or independently as itself.<a name="line.607"></a>
<FONT color="green">608</FONT>         * @exception IOException  If an I/O error occurs while either sending a<a name="line.608"></a>
<FONT color="green">609</FONT>         *      command to the server or receiving a reply from the server.<a name="line.609"></a>
<FONT color="green">610</FONT>         ***/<a name="line.610"></a>
<FONT color="green">611</FONT>        public boolean sendNoOp() throws IOException<a name="line.611"></a>
<FONT color="green">612</FONT>        {<a name="line.612"></a>
<FONT color="green">613</FONT>            return SMTPReply.isPositiveCompletion(noop());<a name="line.613"></a>
<FONT color="green">614</FONT>        }<a name="line.614"></a>
<FONT color="green">615</FONT>    <a name="line.615"></a>
<FONT color="green">616</FONT>    }<a name="line.616"></a>




























































</PRE>
</BODY>
</HTML>
